Skip to main content
Version: 3.1 (latest)

Publishing an Algorithm

An algorithm is a script that can be used to run on top of a compatible dataset (compute type), to produce a distributable output file without having to expose the original data.

To publish an algorithm:

  1. Log in to the marketplace.
  2. From the left navigation bar, go to Create > Algorithm.

Step 1: Connect Your Asset​

  1. Select the Access Type of your Algorithm between a public and private algorithm.
    • Public Algorithm: By making an Algorithm public, Data Consumers can download a copy of Algorithm and/or also use it paired with a Dataset. Compute data owners can choose to trust this Algorithm regardless of the edge node that is used to connect to the Dataset.
    • Private Algorithm: By making an Algorithm private, Data Consumers can only make use of this Algorithm if paired with a Dataset. Compute data owners can only trust this algorithm if the Algorithm is connected to the same edge node as the Dataset.
  2. Select the Algorithm Type for your Algorithm: 'Basic', 'Federated', or 'Aggregate'
    • Basic: used for a single dataset computation.
    • Federated: used to run on multiple datasets simultaneously, producing multiple outputs from computation.
    • Aggregate: used to combine the multiple outputs into a single output.
  3. Select the Edge Node that will connect to the data source.
  4. Paste the Source URL of the dataset.
  5. Optional: Add key-value pairs of HTTP headers in your API by clicking 'Add HTTP Headers'.

Step 2: Basic Information​

  1. If your algorithm does NOT meant to process real data, select 'Experimental'. Otherwise, select 'Production'.
  2. Name your algorithm by providing a concise Algorithm Title that will capture the initial attention of potential data consumers.
  3. Categorize your algorithm according to the closest industry Category.
  4. Provide an Overview of your algorithm as a summary.
  5. Provide Additional Details, or any additional information that you think will be helpful to potential data consumers. E.g., data attributes, purpose, etc.
  6. Select the appropriate Runtime Environment of your algorithm. For Custom Docker Image, indicate the image registry path, digest, entrypoint and reference URL.
  7. Select the Validity Period - how long your algorithm should be available to the data consumer after purchase.

Step 3: Further Details​

  1. Indicate the Asset Permissions - whether to initially 'Allow All Users' or 'Deny All Users' from consuming your data asset.
  2. Optional: Tag your assets with related keywords to make it searchable to a wider audience.
  3. Optional: Upload or link a Sample File that can be downloaded by data consumers before purchasing your actual data.
  4. Optional: Upload a Sample Image file or screenshot of your asset.
  5. Optional: Link your End User License Agreement to specify any terms and conditions for the use of your data asset.

Step 4: Pricing​

  1. Select the pricing type: 'Free', or 'Post-pay'. You will not be able to switch between the pricing types after you have published the asset; however, you can still adjust the actual price if 'Post-pay' pricing is selected.
  2. For Free Pricing, simply click 'Next' to proceed to the next steps. For Post-pay payment, select whether the charging mechanism is 'Set price' or 'Pay-per-byte' and indicate the value

Step 5: Review and Publish​

  1. Review all information. If any update is needed, click 'Edit' to take you to the previous pages or click the 'Go Back' button.
  2. Once finalized, click 'Publish Asset'.